Api.WriteAxisProfileVelocity method

Sets the Profile Velocity of an axis.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

public KsError WriteAxisProfileVelocity(
       int Index,
       int Value
)

Public Function WriteAxisProfileVelocity(
       Index As Integer,
       Value As Integer
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Value

Type: int

The value to write.

Return value

Type: KsError

A return code of a method.

Remarks

• Used in the cyclic callback to update the Profile Velocity of an axis.

• This function can be used only in Manual mode. See the McControlMode enum.

NOTE:  The Profile Velocity is available only if EnableProfilePosition is enabled.

Usable EtherCAT states

ecatOP

Examples

N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace